package com.pl.exception;

import com.pl.common.JsonResult;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.HttpStatus;
import org.springframework.web.bind.MissingServletRequestParameterException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.ResponseStatus;

/**
 * @author shent
 * 1.@ControllerAdvice 注解包含了 @Component 注解，
 * 说明在 Spring Boot 启动时，也会把该类作为组件交给 Spring 来管理。
 * 除此之外，该注解还有个 basePackages 属性，该属性是用来拦截哪个包中的异常信息，
 * 一般我们不指定这个属性，我们拦截项目工程中的所有异常。
 * 2.@ResponseBody 注解是为了异常处理完之后给调用方输出一个 json 格式的封装数据。
 */
@ControllerAdvice
@ResponseBody
public class GlobalExceptionHandler {
    private static final Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler.class);

    /**
     * 拦截业务异常，返回业务异常信息
     *
     * @param e
     * @return
     */
    @ExceptionHandler(BusinessErrorException.class)
    @ResponseStatus(value = HttpStatus.INTERNAL_SERVER_ERROR)
    public JsonResult handleBusinessError(BusinessErrorException e) {
        String code = e.getCode();
        String message = e.getMessage();
        return new JsonResult(code, message);
    }

    /**
     * 缺少请求参数异常
     *
     * @param e NullPointerException
     * @return
     */
    @ExceptionHandler(MissingServletRequestParameterException.class)
    @ResponseStatus(value = HttpStatus.BAD_REQUEST)
    public JsonResult handleHttpMessageNotReadableException(MissingServletRequestParameterException e) {
        logger.error("缺少请求参数,{}", e.getMessage());
        return new JsonResult("400", "缺少必要的请求参数");

    }

    /**
     * 空指针异常
     *
     * @param e NullPointerException
     * @return
     */
    @ExceptionHandler(NullPointerException.class)
    @ResponseStatus(value = HttpStatus.INTERNAL_SERVER_ERROR)
    public JsonResult handleTypeMismatchException(MissingServletRequestParameterException e) {
        logger.error("空指针异常,{}", e.getMessage());
        return new JsonResult("500", "空指针异常");
    }

    /**
     * 系统异常 预期以外异常
     * 但是项目中，我们一般都会比较详细的去拦截一些常见异常，拦截 Exception 虽然可以一劳永逸，但是不利于我们去排查或者定位问题。实际项目中，可以把拦截 Exception 异常写在 GlobalExceptionHandler 最下面，如果都没有找到，最后再拦截一下 Exception 异常，保证输出信息友好。
     *
     * @param e
     * @return
     */
    @ExceptionHandler(Exception.class)
    @ResponseStatus(value = HttpStatus.INTERNAL_SERVER_ERROR)
    public JsonResult handleUnexpectedServer(Exception e) {
        logger.error("系统异常：", e);
        return new JsonResult("500", "系统发生异常，请联系管理员");
    }
}
